Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added GH Actions summary #174

Merged
merged 2 commits into from
Dec 12, 2022
Merged

Added GH Actions summary #174

merged 2 commits into from
Dec 12, 2022

Conversation

faisal-alvi
Copy link
Member

@faisal-alvi faisal-alvi commented Dec 7, 2022

Description of the Change

This PR utilizes the new Markdown support of GH Actions summary (suggested by @jeffpaul) to include the test result in the job summary: https://github.com/10up/cypress-wp-utils/actions/runs/2319016114

To generate the markdown report, this PR uses mochawesome reporter. The reporter generates JSON and HTML reports. The report is pretty and solid:

image

Closes #158

How to test the Change

Check the GitHub Action result, it should display the Cypress test result summary.

Changelog Entry

Added - A GH Actions summary

Credits

Props @faisal-alvi @jeffpaul

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests pass.

@faisal-alvi faisal-alvi added this to the Future Release milestone Dec 7, 2022
@faisal-alvi faisal-alvi self-assigned this Dec 7, 2022
@faisal-alvi faisal-alvi mentioned this pull request Dec 7, 2022
4 tasks
@faisal-alvi faisal-alvi requested review from a team and iamdharmesh and removed request for a team December 7, 2022 12:49
@jeffpaul jeffpaul modified the milestones: Future Release, 2.7.0 Dec 8, 2022
@faisal-alvi faisal-alvi modified the milestones: 2.7.0, Future Release Dec 8, 2022
Copy link
Member

@iamdharmesh iamdharmesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we have to add if: ${{ always() }} to the Update summary step otherwise it will only run when the E2E test succeeds and will be skipped for test failures.

.github/workflows/cypress.yml Show resolved Hide resolved
@jeffpaul jeffpaul modified the milestones: Future Release, 2.8.0 Dec 9, 2022
Co-authored-by: Dharmesh Patel <dspatel44@gmail.com>
Copy link
Member

@iamdharmesh iamdharmesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for adding this @faisal-alvi. LGTM 🚀

@faisal-alvi faisal-alvi merged commit c7b54df into develop Dec 12, 2022
@faisal-alvi faisal-alvi deleted the gh-summary branch December 12, 2022 16:14
@jeffpaul
Copy link
Member

@10up/open-source-practice I'd love to see this similarly replicated across our other projects as well as a note on how to do so for future projects added to the Open Source Best Practices... please and thanks!

@faisal-alvi faisal-alvi modified the milestones: 2.8.0, 2.7.2 Jan 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a GH Actions summary
3 participants